Skip to content

server.ts: remove port and host fallbacks in run#4634

Merged
tdonohue merged 2 commits into
DSpace:mainfrom
alanorth:server-setup
Sep 10, 2025
Merged

server.ts: remove port and host fallbacks in run#4634
tdonohue merged 2 commits into
DSpace:mainfrom
alanorth:server-setup

Conversation

@alanorth
Copy link
Copy Markdown
Contributor

@alanorth alanorth commented Aug 9, 2025

Description

In server.ts, when setting up the server we attempt to retrieve the port and host from the configuration interface:

function run() {
  const port = environment.ui.port || 4000;
  const host = environment.ui.host || '/';

In the case of environment.ui.host, if the value is Falsy then we fall back to "/", which is not even a valid host! In my opinion, because we set sane defaults for both of these in src/config/default-app-config.ts, we should not attempt to further catch errors as the user would have had to go to quite a length to mess things up this bad.

I propose removing these fallbacks entirely. This buggy configuration is present in DSpace 7–main (current 10.0-SNAPSHOT).

Instructions for Reviewers

Please add a more detailed description of the changes made by your PR. At a minimum, providing a bulleted list of changes in your PR is helpful to reviewers.

List of changes in this PR:

  • First, remove fallback for environment.ui.host in server.ts
  • Second, remove fallback for environment.ui.port in server.ts

Include guidance for how to test or review your PR. This may include: steps to reproduce a bug, screenshots or description of a new feature, or reasons behind specific changes.

Make sure the application builds and runs.

Checklist

This checklist provides a reminder of what we are going to look for when reviewing your PR. You do not need to complete this checklist prior creating your PR (draft PRs are always welcome).
However, reviewers may request that you complete any actions in this list if you have not done so. If you are unsure about an item in the checklist, don't hesitate to ask. We're here to help!

  • My PR is created against the main branch of code (unless it is a backport or is fixing an issue specific to an older branch).
  • My PR is small in size (e.g. less than 1,000 lines of code, not including comments & specs/tests), or I have provided reasons as to why that's not possible.
  • My PR passes ESLint validation using npm run lint
  • My PR doesn't introduce circular dependencies (verified via npm run check-circ-deps)
  • My PR includes TypeDoc comments for all new (or modified) public methods and classes. It also includes TypeDoc for large or complex private methods.
  • My PR passes all specs/tests and includes new/updated specs or tests based on the Code Testing Guide.
  • My PR aligns with Accessibility guidelines if it makes changes to the user interface.
  • My PR uses i18n (internationalization) keys instead of hardcoded English text, to allow for translations.
  • My PR includes details on how to test it. I've provided clear instructions to reviewers on how to successfully test this fix or feature.
  • If my PR includes new libraries/dependencies (in package.json), I've made sure their licenses align with the DSpace BSD License based on the Licensing of Contributions documentation.
  • If my PR includes new features or configurations, I've provided basic technical documentation in the PR itself.
  • If my PR fixes an issue ticket, I've linked them together.

If `environment.ui.host` is Falsy, then we attempt to fall back to
a host value of '/', which is invalid. I think that, if a user has
messed up their config so much that defaults in our configuration
interface don't work, then we should actually fail here.
If a user has messed up their config so much that the fallbacks in
our default configuration interface don't work then we should just
fail here.
@alanorth alanorth added bug low priority port to dspace-7_x This PR needs to be ported to `dspace-7_x` branch for next bug-fix release affects: 8.x Issue impacts 8.x releases port to dspace-8_x This PR needs to be ported to `dspace-8_x` branch for next bug-fix release port to dspace-9_x This PR needs to be ported to `dspace-9_x` branch for next bug-fix release and removed affects: 8.x Issue impacts 8.x releases labels Aug 9, 2025
@tdonohue tdonohue added this to the 10.0 milestone Aug 20, 2025
@tdonohue tdonohue moved this to 🙋 Needs Reviewers Assigned in DSpace 10.0 Release Aug 20, 2025
@tdonohue tdonohue self-requested a review August 20, 2025 20:45
Copy link
Copy Markdown
Member

@tdonohue tdonohue left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 Thanks @alanorth ! I agree with this small change. The "sane defaults" are already in default-app-config.ts.

@github-project-automation github-project-automation Bot moved this from 🙋 Needs Reviewers Assigned to 👍 Reviewer Approved in DSpace 10.0 Release Sep 10, 2025
@tdonohue tdonohue merged commit dc9137b into DSpace:main Sep 10, 2025
14 checks passed
@github-project-automation github-project-automation Bot moved this from 👍 Reviewer Approved to ✅ Done in DSpace 10.0 Release Sep 10, 2025
@dspace-bot
Copy link
Copy Markdown
Contributor

Successfully created backport PR for dspace-7_x:

@dspace-bot
Copy link
Copy Markdown
Contributor

Successfully created backport PR for dspace-8_x:

@dspace-bot
Copy link
Copy Markdown
Contributor

Successfully created backport PR for dspace-9_x:

@tdonohue tdonohue removed port to dspace-7_x This PR needs to be ported to `dspace-7_x` branch for next bug-fix release port to dspace-8_x This PR needs to be ported to `dspace-8_x` branch for next bug-fix release port to dspace-9_x This PR needs to be ported to `dspace-9_x` branch for next bug-fix release labels Sep 10, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

Status: ✅ Done

Development

Successfully merging this pull request may close these issues.

3 participants